KFbxSelectionNode Class Reference

#include <kfbxselectionnode.h>

Inheritance diagram for KFbxSelectionNode:

[legend]

List of all members.

---

Detailed Description

KFbxSelectionNode is an auxiliary class for Selection Set.

Used to group objects with their components (e.g. vertex, edge, and face), when adding it to a selection set (KFbxSelectionSet).

See also:

KFbxSelectionSet

Definition at line 50 of file kfbxselectionnode.h.

Public Types
enum	ESelectType {    eVERTEX_LEVEL,    eEDGE_LEVEL,    eFACE_LEVEL,    eOBJECT_LEVEL,    eSELECT_TYPE_NUM }
	SelectionNode type identifier. More...
Public Member Functions
bool	SetSelectionObject (KFbxObject *pObject)
	Set an object whose components or itself is contained in the SelectionNode.
KFbxObject *	GetSelectionObject () const
	Get the object whose components or itself or both are contained in the SelectionNode.
bool	IsValid () const
	To detect if the SelectionNode is valid.
Public Attributes
bool	mIsTheNodeInSet
	true means the object itself is also in the selection set; false means only the object's components are in the selection set, the object is not.
KArrayTemplate< int >	mVertexIndexArray
	Index array for selected vertices.
KArrayTemplate< int >	mEdgeIndexArray
	Index array for selected edges.
KArrayTemplate< int >	mPolygonIndexArray
	Index array for selected faces.

---

Member Enumeration Documentation

enum ESelectType

SelectionNode type identifier.

• eVERTEX_LEVEL Vertex level selection.
• eEDGE_LEVEL Edge level selection.
• eFACE_LEVEL Face level selection.
• eOBJECT_LEVEL Object level selection.
• eSELECT_TYPE_NUM Number of Select Types.

Enumerator:

eVERTEX_LEVEL
eEDGE_LEVEL
eFACE_LEVEL
eOBJECT_LEVEL
eSELECT_TYPE_NUM

Definition at line 62 of file kfbxselectionnode.h.

---

Member Function Documentation

bool SetSelectionObject

(

KFbxObject *

pObject

)

Set an object whose components or itself is contained in the SelectionNode.

Parameters:

pObject

The object whose components or itself is contained in the SelectionNode.

Returns:

true if the object is set successfully. false otherwise.

Remarks:

It is possible a SDK user will try to set multiple objects to one SelectionNode, but only the last one will be kept.

KFbxObject* GetSelectionObject

(

)

const

Get the object whose components or itself or both are contained in the SelectionNode.

Returns:

The object whose components or itself or both are contained in the SelectionNode.

bool IsValid

(

)

const

To detect if the SelectionNode is valid.

Returns:

true if this is a valid SelectionNode. false otherwise.

Remarks:

SelectionNode is valid if selection object is set. SelectionNode is not valid if no selection object is set.

---

Member Data Documentation

bool mIsTheNodeInSet

true means the object itself is also in the selection set; false means only the object's components are in the selection set, the object is not.

Definition at line 93 of file kfbxselectionnode.h.

KArrayTemplate<int> mVertexIndexArray

Index array for selected vertices.

Definition at line 97 of file kfbxselectionnode.h.

KArrayTemplate<int> mEdgeIndexArray

Index array for selected edges.

Definition at line 101 of file kfbxselectionnode.h.

KArrayTemplate<int> mPolygonIndexArray

Index array for selected faces.

Definition at line 105 of file kfbxselectionnode.h.